<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.11"/>
<title>Kinetis Bootloader Host: blfwk::CommandPacket Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="nxp_logo_small.png"/></td>
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">Kinetis Bootloader Host
   &#160;<span id="projectnumber">2.0.0</span>
   </div>
   <div id="projectbrief">Host Tools for Kinetis devices</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Introduction</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('classblfwk_1_1_command_packet.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-types">Protected Types</a> &#124;
<a href="#pro-attribs">Protected Attributes</a> &#124;
<a href="classblfwk_1_1_command_packet-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">blfwk::CommandPacket Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p><a class="el" href="classblfwk_1_1_command.html" title="Represents a bootloader command. ">Command</a> packet operations.  
 <a href="classblfwk_1_1_command_packet.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="_command_8h_source.html">Command.h</a>&gt;</code></p>
<div id="dynsection-0" onclick="return toggleVisibility(this)" class="dynheader closed" style="cursor:pointer;">
  <img id="dynsection-0-trigger" src="closed.png" alt="+"/> Collaboration diagram for blfwk::CommandPacket:</div>
<div id="dynsection-0-summary" class="dynsummary" style="display:block;">
</div>
<div id="dynsection-0-content" class="dyncontent" style="display:none;">
<div class="center"><iframe scrolling="no" frameborder="0" src="classblfwk_1_1_command_packet__coll__graph.svg" width="170" height="142"><p><b>This browser is not able to show SVG: try Firefox, Chrome, Safari, or Opera instead.</b></p></iframe>
</div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structblfwk_1_1_command_packet_1_1_packet_with_args.html">PacketWithArgs</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Format of command packet.  <a href="structblfwk_1_1_command_packet_1_1_packet_with_args.html#details">More...</a><br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a53cd71af0625af82f9c66bcc63349e0d"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a53cd71af0625af82f9c66bcc63349e0d"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a53cd71af0625af82f9c66bcc63349e0d">CommandPacket</a> (uint8_t tag, uint8_t flags=0)</td></tr>
<tr class="memdesc:a53cd71af0625af82f9c66bcc63349e0d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes no command arguments. <br /></td></tr>
<tr class="separator:a53cd71af0625af82f9c66bcc63349e0d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a478ab252b0f34da571bb6dae3853c9b8"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a478ab252b0f34da571bb6dae3853c9b8"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a478ab252b0f34da571bb6dae3853c9b8">CommandPacket</a> (uint8_t tag, uint8_t flags, uint32_t arg)</td></tr>
<tr class="memdesc:a478ab252b0f34da571bb6dae3853c9b8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes one command argument. <br /></td></tr>
<tr class="separator:a478ab252b0f34da571bb6dae3853c9b8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a002f9721368f1406fea60fbd4a17efd5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a002f9721368f1406fea60fbd4a17efd5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a002f9721368f1406fea60fbd4a17efd5">CommandPacket</a> (uint8_t tag, uint8_t flags, uint32_t arg1, uint32_t arg2)</td></tr>
<tr class="memdesc:a002f9721368f1406fea60fbd4a17efd5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes two command arguments. <br /></td></tr>
<tr class="separator:a002f9721368f1406fea60fbd4a17efd5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a7c00d6e5ea62fa339c5ec4470c3c44d5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7c00d6e5ea62fa339c5ec4470c3c44d5"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a7c00d6e5ea62fa339c5ec4470c3c44d5">CommandPacket</a> (uint8_t tag, uint8_t flags, uint32_t arg1, uint32_t arg2, uint32_t arg3)</td></tr>
<tr class="memdesc:a7c00d6e5ea62fa339c5ec4470c3c44d5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes three command arguments. <br /></td></tr>
<tr class="separator:a7c00d6e5ea62fa339c5ec4470c3c44d5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac98432b22a7a5b403343e932940d41a3"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="ac98432b22a7a5b403343e932940d41a3"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#ac98432b22a7a5b403343e932940d41a3">CommandPacket</a> (uint8_t tag, uint8_t flags, uint32_t arg1, uint32_t arg2, uint32_t arg3, uint32_t arg4)</td></tr>
<tr class="memdesc:ac98432b22a7a5b403343e932940d41a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor that takes four command arguments. <br /></td></tr>
<tr class="separator:ac98432b22a7a5b403343e932940d41a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67ea376edf52a9adbfaddfed0462241a"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a67ea376edf52a9adbfaddfed0462241a"></a>
uint32_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a67ea376edf52a9adbfaddfed0462241a">getSize</a> () const </td></tr>
<tr class="memdesc:a67ea376edf52a9adbfaddfed0462241a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get size of command packet, including arguments. <br /></td></tr>
<tr class="separator:a67ea376edf52a9adbfaddfed0462241a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a499d19940835d240d93ccf5df343cdf5"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a499d19940835d240d93ccf5df343cdf5"></a>
const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a499d19940835d240d93ccf5df343cdf5">getData</a> ()</td></tr>
<tr class="memdesc:a499d19940835d240d93ccf5df343cdf5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get pointer to command packet data. <br /></td></tr>
<tr class="separator:a499d19940835d240d93ccf5df343cdf5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1121ade7ada4d28960f016723ae6ed42"><td class="memItemLeft" align="right" valign="top">const uint8_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a1121ade7ada4d28960f016723ae6ed42">sendCommandGetResponse</a> (<a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> &amp;device)</td></tr>
<tr class="memdesc:a1121ade7ada4d28960f016723ae6ed42"><td class="mdescLeft">&#160;</td><td class="mdescRight">Send command packet and read response.  <a href="#a1121ade7ada4d28960f016723ae6ed42">More...</a><br /></td></tr>
<tr class="separator:a1121ade7ada4d28960f016723ae6ed42"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-types"></a>
Protected Types</h2></td></tr>
<tr class="memitem:aaa92f2f4819d52ff5df89c41ccd53332"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#aaa92f2f4819d52ff5df89c41ccd53332">_command_packet_constants</a> { <a class="el" href="classblfwk_1_1_command_packet.html#aaa92f2f4819d52ff5df89c41ccd53332aebee90234688c4eb050571ca4b8bd6d0">kMaxCommandArguments</a>
 }<tr class="memdesc:aaa92f2f4819d52ff5df89c41ccd53332"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constants.  <a href="classblfwk_1_1_command_packet.html#aaa92f2f4819d52ff5df89c41ccd53332">More...</a><br /></td></tr>
</td></tr>
<tr class="separator:aaa92f2f4819d52ff5df89c41ccd53332"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a7f5f4c5cc718477b050ca02fb81ccbbc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7f5f4c5cc718477b050ca02fb81ccbbc"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a7f5f4c5cc718477b050ca02fb81ccbbc">m_numArguments</a></td></tr>
<tr class="memdesc:a7f5f4c5cc718477b050ca02fb81ccbbc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Number of command arguments. <br /></td></tr>
<tr class="separator:a7f5f4c5cc718477b050ca02fb81ccbbc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a042c08cf996d7ee9a967318f7fa599b7"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a042c08cf996d7ee9a967318f7fa599b7"></a>
<a class="el" href="structblfwk_1_1_command_packet_1_1_packet_with_args.html">PacketWithArgs</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classblfwk_1_1_command_packet.html#a042c08cf996d7ee9a967318f7fa599b7">m_packet</a></td></tr>
<tr class="memdesc:a042c08cf996d7ee9a967318f7fa599b7"><td class="mdescLeft">&#160;</td><td class="mdescRight"><a class="el" href="classblfwk_1_1_command.html" title="Represents a bootloader command. ">Command</a> packet data. <br /></td></tr>
<tr class="separator:a042c08cf996d7ee9a967318f7fa599b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p><a class="el" href="classblfwk_1_1_command.html" title="Represents a bootloader command. ">Command</a> packet operations. </p>
<p>Formats command packets and runs the command phase. </p>
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
<a class="anchor" id="aaa92f2f4819d52ff5df89c41ccd53332"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">enum <a class="el" href="classblfwk_1_1_command_packet.html#aaa92f2f4819d52ff5df89c41ccd53332">blfwk::CommandPacket::_command_packet_constants</a></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Constants. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="aaa92f2f4819d52ff5df89c41ccd53332aebee90234688c4eb050571ca4b8bd6d0"></a>kMaxCommandArguments&#160;</td><td class="fielddoc">
<p>7 args max for packet size 32 bytes </p>
</td></tr>
</table>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a1121ade7ada4d28960f016723ae6ed42"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">const uint8_t * blfwk::CommandPacket::sendCommandGetResponse </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classblfwk_1_1_packetizer.html">Packetizer</a> &amp;&#160;</td>
          <td class="paramname"><em>device</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Send command packet and read response. </p>
<p>See host_command.h for documentation on this function.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to response packet. </dd></dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following files:<ul>
<li><a class="el" href="_command_8h_source.html">Command.h</a></li>
<li>Command.cpp</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><b>blfwk</b></li><li class="navelem"><a class="el" href="classblfwk_1_1_command_packet.html">CommandPacket</a></li>
    <li class="footer">Generated on Mon Mar 7 2016 16:49:51 for Kinetis Bootloader Host by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.11 </li>
  </ul>
</div>
</body>
</html>
